| API Documentation |  |

- MAIN PAGE
- NAMESPACES
- CLASSES

Static Public Member Functions | List of all members
nkGraphics::FilterUtils Class Referencefinal

Offers utility to work with the associated enumeration. More...

## Static Public Member Functions
static nkMemory::StringView | toString (FILTER value)
static FILTER | fromString (nkMemory::StringView value)
static FILTER | fromIndex (unsigned int value)

## Detailed Description

Offers utility to work with the associated enumeration.

## Member Function Documentation

## ◆ toString()

static nkMemory::StringView nkGraphics::FilterUtils::toString | ( | FILTER | value | ) |
| static

Converts an enum entry to its string representation.

Parameters

  value | The enum value to convert.

Returns
  The string expressing the enum value, "UNKNOWN" if the value is not in the enum range.

## ◆ fromString()

static FILTER nkGraphics::FilterUtils::fromString | ( | nkMemory::StringView | value | ) |
| static

Converts a string to its equivalent enum value.

Parameters

  value | The string to convert.

Returns
  The enum value associated with the string, FILTER::MIN_MAG_MIP_POINT if the string does not represent an enumeration value.

## ◆ fromIndex()

static FILTER nkGraphics::FilterUtils::fromIndex | ( | unsigned int | value | ) |
| static

Retrieves an enum value by index. Allows to loop over all values, for instance.

Parameters

  value | The index of the enum to retrieve.

Returns
  The enum value with index associated, -1 if no value available.

The documentation for this class was generated from the following file:

- Documentation/Headers/NilkinsGraphics/Samplers/Enums/Filter.h